PDF’s genereren vanuit Word-sjablonen in Ruby

Met DocuGenerate kunt u PDF- en Word-documenten rechtstreeks vanuit uw Ruby-applicatie maken. Deze handleiding laat zien hoe u elke API-methode aanroept vanuit Ruby 3.0 of hoger. Zie de API-referentie voor de volledige lijst met parameters en antwoorden.

Samenvatting

1. Authenticatie
2. Sjabloon maken
3. Sjablonen weergeven
4. Sjabloon ophalen
5. Sjabloon bijwerken
6. Sjabloon verwijderen
7. Document genereren
8. Documenten weergeven
9. Document ophalen
10. Document bijwerken
11. Document verwijderen

1. Authenticatie

Elk verzoek wordt geauthenticeerd door uw API-sleutel mee te sturen in de header Authorization. Bewaar de sleutel in een omgevingsvariabele in plaats van hem hard te coderen in uw broncode:

export DOCUGENERATE_API_KEY="YOUR-API-KEY"

De voorbeelden gebruiken net/http en json uit de standaardbibliotheek van Ruby, dus u hoeft niets te installeren. Ze gebruiken allemaal deze requires en constanten. Omdat net/http geen uitzondering genereert bij HTTP-foutstatussen, controleert elk voorbeeld het antwoord voordat het wordt gelezen:

require 'net/http'
require 'json'

API_URL = 'https://api.docugenerate.com/v1'
API_KEY = ENV['DOCUGENERATE_API_KEY']

Als uw account gegevens in een andere regio opslaat, vervang dan de basis-URL door het bijbehorende regionale eindpunt, bijvoorbeeld https://api.eu.docugenerate.com/v1.

2. Sjabloon maken

Om een sjabloon te maken, uploadt u het sjabloonbestand met een verzoek naar POST /template. Dit eindpunt vereist het content type multipart/form-data, dat set_form automatisch instelt, samen met de multipart-boundary:

uri = URI("#{API_URL}/template")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Business Letter.docx') do |file|
  request.set_form(
    [
      ['file', file],
      ['name', 'Business Letter']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end

  template = JSON.parse(response.body)
  puts template['id']
end

Stel de header Content-Type niet zelf in, anders ontbreekt de boundary en mislukt het verzoek. Het antwoord bevat het nieuwe sjabloon, inclusief de tags die automatisch in het bestand zijn gedetecteerd:

{
  "enhanced_syntax": false,
  "versioning_enabled": false,
  "folder": [],
  "tags": {
    "valid": [
      "Date",
      "Name",
      "Job Title",
      "Company Name",
      "Street Address",
      "City",
      "State",
      "Zip Code",
      "Email",
      "Phone"
    ],
    "invalid": []
  },
  "created": 1791055374301,
  "updated": 1791055374301,
  "name": "Business Letter",
  "delimiters": {
    "left": "[",
    "right": "]"
  },
  "filename": "Business Letter.docx",
  "format": ".docx",
  "region": "eu",
  "page_count": 1,
  "image_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.png?alt=media&token=0ce64a4b-495a-426b-8783-42b479f7ae38",
  "preview_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.pdf?alt=media&token=0b3939c7-824e-4979-9aca-ca4a87175cbf",
  "template_uri": "https://firebasestorage.googleapis.com/v0/b/storage.eu.docugenerate.com/o/templates%2FuVE30i1427KQsYcED0bl%2FBusiness%20Letter.docx?alt=media&token=d37a4458-3620-48db-94b8-6ac46f0442ab",
  "id": "uVE30i1427KQsYcED0bl"
}

Bewaar de id van het sjabloon, want u hebt die nodig om documenten te genereren. De volgende optionele parameters kunnen ook aan het formulier worden toegevoegd:

delimiters: De scheidingstekens waarmee de tags worden gedetecteerd, verzonden als JSON-string, bijv. { left: '[', right: ']' }.to_json. Standaard worden ze automatisch bepaald.
region: Waar het sjabloon en de gegenereerde documenten worden opgeslagen, us, eu, uk of au. Standaard wordt de regio van het account gebruikt.
enhanced_syntax: Stel in op 'true' om geneste eigenschappen en logische of wiskundige operatoren in de tags te gebruiken.
versioning_enabled: Stel in op 'true' om eerdere versies van het bestand te bewaren bij het uploaden van een nieuw bestand, als uw plan dit toestaat.
folder: De map van het sjabloon, van de hoofdmap tot het laagste niveau. Ontbrekende mappen worden automatisch aangemaakt.

Om het sjabloon in een map te plaatsen, voegt u voor elk niveau van het pad een folder-veld toe. Bijvoorbeeld om het in de map Letters > Business te plaatsen:

request.set_form(
  [
    ['file', file],
    ['name', 'Business Letter'],
    ['folder', 'Letters'],
    ['folder', 'Business']
  ],
  'multipart/form-data'
)

3. Sjablonen weergeven

Een verzoek naar GET /template retourneert alle sjablonen in uw account:

uri = URI("#{API_URL}/template")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

templates = JSON.parse(response.body)
templates.each do |template|
  puts "#{template['id']} #{template['name']}"
end

Om alleen de sjablonen van een map weer te geven, herhaalt u de queryparameter folder voor elk niveau van het pad. Bijvoorbeeld om de sjablonen in de map Letters > Business weer te geven:

uri = URI("#{API_URL}/template")
uri.query = URI.encode_www_form(
  [
    ['folder', 'Letters'],
    ['folder', 'Business']
  ]
)

request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

Alleen de sjablonen die direct in die map staan, worden geretourneerd. Sjablonen in de submappen worden niet meegenomen. Lees meer over hoe u met de API sjablonen in mappen organiseert.

4. Sjabloon ophalen

Om één sjabloon op te halen, roept u GET /template/{id} aan met de ID ervan:

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

template = JSON.parse(response.body)
puts template['tags']['valid']

Dit is bijvoorbeeld handig om te controleren welke merge-tags het sjabloon verwacht voordat u documenten genereert.

5. Sjabloon bijwerken

Een verzoek naar PUT /template/{id} werkt een sjabloon bij. Alle parameters zijn optioneel, dus stuur alleen de parameters mee die u wilt wijzigen. Bijvoorbeeld om een nieuwe versie van het bestand te uploaden en het sjabloon te hernoemen:

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Put.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Business Letter v2.docx') do |file|
  request.set_form(
    [
      ['file', file],
      ['name', 'Business Letter v2']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end

  template = JSON.parse(response.body)
end

Net als bij het maken van een sjabloon moet de body multipart/form-data zijn, wat set_form automatisch instelt, samen met de multipart-boundary. Naast file en name kunnen de volgende optionele parameters aan het formulier worden toegevoegd:

delimiters: De nieuwe scheidingstekens, verzonden als JSON-string. Indien opgegeven, wordt het sjabloon opnieuw geanalyseerd om de merge-tags te detecteren op basis van de nieuwe scheidingstekens. Wanneer een nieuw file wordt geüpload zonder delimiters, worden de huidige scheidingstekens gebruikt.
region: Verplaatst het sjabloon naar een andere regio, us, eu, uk of au. Documenten die daarna worden gegenereerd, worden in de nieuwe regio opgeslagen, terwijl bestaande documenten in hun huidige regio blijven.
folder: Verplaatst het sjabloon naar een andere map, met één folder-veld voor elk niveau van het pad. Stuur '[]' om het sjabloon uit elke map te halen.
enhanced_syntax: Stel in op 'true' of 'false' om de uitgebreide syntax in of uit te schakelen.
versioning_enabled: Stel in op 'true' of 'false' om de versiegeschiedenis in of uit te schakelen, als uw plan dit toestaat.

6. Sjabloon verwijderen

Om een sjabloon te verwijderen, stuurt u een verzoek naar DELETE /template/{id}. De API antwoordt bij succes met de status 204 No Content:

template_id = 'bet2oQirk0pSd9ctH9Qu'

uri = URI("#{API_URL}/template/#{template_id}")
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

7. Document genereren

U genereert documenten met een verzoek naar POST /document, waarbij u de template_id en de data meegeeft waarmee de merge-tags worden vervangen:

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => {
    'Date' => 'October 4, 2026',
    'Name' => 'Emily Carter',
    'Job Title' => 'Operations Manager',
    'Company Name' => 'Harbor Point Consulting',
    'Street Address' => '118 West Street',
    'City' => 'Annapolis',
    'State' => 'Maryland',
    'Zip Code' => '21405',
    'Email' => 'emily.carter@example.com',
    'Phone' => '(410) 555-0142'
  },
  'output_format' => '.pdf'
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)
puts document['document_uri']

Het antwoord bevat de eigenschappen van het document:

{
  "created": 1791125416372,
  "template_id": "bet2oQirk0pSd9ctH9Qu",
  "name": "Business Letter",
  "format": ".pdf",
  "data_length": 1,
  "filename": "Business Letter.pdf",
  "document_uri": "https://firebasestorage.googleapis.com/v0/b/storage.us.docugenerate.com/o/documents%2FiESelthRt4uaYQRTemrL%2FBusiness%20Letter.pdf?alt=media&token=c4b259ec-249b-4b35-a62f-6a8dc0da75f3",
  "id": "iESelthRt4uaYQRTemrL"
}

Het output_format kan .docx (standaard), .pdf, .doc, .odt, .txt, .html, .png of een PDF/A-versie zijn. U kunt ook met merge_with PDF-bestanden samenvoegen aan het einde van het gegenereerde document, of met attach bijlagen toevoegen.

Het bestand downloaden
De document_uri verwijst naar het gegenereerde bestand, dat u kunt downloaden en op schijf kunt opslaan:

file = Net::HTTP.get_response(URI(document['document_uri']))

unless file.is_a?(Net::HTTPSuccess)
  raise "Download failed with status #{file.code}"
end

File.binwrite(document['filename'], file.body)

Het bestand direct ontvangen
Als u niet wilt dat het document in de cloud wordt opgeslagen, stel dan de header Accept in op application/octet-stream. De API antwoordt dan met het binaire bestand in plaats van JSON:

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/octet-stream'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => {
    'Date' => 'October 4, 2026',
    'Name' => 'Emily Carter',
    'Job Title' => 'Operations Manager',
    'Company Name' => 'Harbor Point Consulting',
    'Street Address' => '118 West Street',
    'City' => 'Annapolis',
    'State' => 'Maryland',
    'Zip Code' => '21405',
    'Email' => 'emily.carter@example.com',
    'Phone' => '(410) 555-0142'
  },
  'output_format' => '.pdf'
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

File.binwrite('Business Letter.pdf', response.body)
puts response['X-Document-Id']

Batchgewijze documentgeneratie
Om meerdere documenten in één verzoek te genereren, geeft u een array van hashes mee als data. Voor elke hash wordt een document gegenereerd:

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => [
    { 'Date' => 'October 4, 2026', 'Name' => 'Emily Carter', 'Job Title' => 'Operations Manager', 'Company Name' => 'Harbor Point Consulting', 'Street Address' => '118 West Street', 'City' => 'Annapolis', 'State' => 'Maryland', 'Zip Code' => '21405', 'Email' => 'emily.carter@example.com', 'Phone' => '(410) 555-0142' },
    { 'Date' => 'October 4, 2026', 'Name' => 'Daniel Brooks', 'Job Title' => 'Logistics Coordinator', 'Company Name' => 'Northfield Logistics', 'Street Address' => '2400 South Lamar Boulevard', 'City' => 'Austin', 'State' => 'Texas', 'Zip Code' => '78704', 'Email' => 'daniel.brooks@example.com', 'Phone' => '(512) 555-0187' }
  ],
  'output_format' => '.pdf',
  'single_file' => true,
  'page_break' => true
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

Standaard worden alle documenten samengevoegd in één bestand, met een pagina-einde na elk document. Stel page_break in op false om de pagina-eindes te verwijderen.

Wanneer single_file op false staat, wordt per data-object een bestand gegenereerd en worden alle bestanden gegroepeerd in een .zip-archief. Gebruik de parameter name om het archief een naam te geven, en output_name met merge-tags om elk bestand een dynamische naam te geven, zoals Letter for [Name]:

request.body = {
  'template_id' => 'bet2oQirk0pSd9ctH9Qu',
  'data' => [...],
  'output_format' => '.pdf',
  'single_file' => false,
  'name' => 'Business Letters',
  'output_name' => 'Letter for [Name]'
}.to_json

Dit genereert een archief Business Letters.zip met Letter for Emily Carter.pdf en Letter for Daniel Brooks.pdf. De merge-tags in output_name moeten dezelfde scheidingstekens gebruiken als het sjabloon.

Een gegevensbestand gebruiken
Om documenten in bulk te genereren vanuit een Excel- of CSV-bestand, verstuurt u het bestand in een multipart/form-data-verzoek. Voor elke rij van het spreadsheet wordt een document gegenereerd. Als het bestand meerdere werkbladen bevat, geef dan met de parameter sheet aan welk werkblad u wilt gebruiken.

uri = URI("#{API_URL}/document")
request = Net::HTTP::Post.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'

File.open('Data.xlsx') do |file|
  request.set_form(
    [
      ['template_id', 'bet2oQirk0pSd9ctH9Qu'],
      ['file', file],
      ['output_format', '.pdf']
    ],
    'multipart/form-data'
  )
  response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

  unless response.is_a?(Net::HTTPSuccess)
    raise "DocuGenerate API error #{response.code}: #{response.body}"
  end
end

Een gegevensbestand gebruiken is een andere vorm van batchgeneratie, dus dezelfde parameters gelden voor het samenvoegen van de gegenereerde documenten in één bestand of het groeperen ervan in een .zip-archief met een eigen naam voor elk bestand.

8. Documenten weergeven

Een verzoek naar GET /document retourneert de documenten die op basis van een sjabloon zijn gegenereerd. De ID van het sjabloon wordt meegegeven in de queryparameter template_id:

uri = URI("#{API_URL}/document")
uri.query = URI.encode_www_form(template_id: 'bet2oQirk0pSd9ctH9Qu')

request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

documents = JSON.parse(response.body)
documents.each do |document|
  puts "#{document['id']} #{document['name']} #{document['document_uri']}"
end

9. Document ophalen

Om één document op te halen, roept u GET /document/{id} aan met de ID ervan:

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Get.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

10. Document bijwerken

Een verzoek naar PUT /document/{id} hernoemt een document, want de naam is de enige eigenschap die kan worden bijgewerkt:

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Put.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = { 'name' => 'Letter for Emily Carter' }.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

document = JSON.parse(response.body)

11. Document verwijderen

Om een document te verwijderen, stuurt u een verzoek naar DELETE /document/{id}. De API antwoordt bij succes met de status 204 No Content:

document_id = 'iESelthRt4uaYQRTemrL'

uri = URI("#{API_URL}/document/#{document_id}")
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = API_KEY
request['Accept'] = 'application/json'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

unless response.is_a?(Net::HTTPSuccess)
  raise "DocuGenerate API error #{response.code}: #{response.body}"
end

🆕 Ruby SDK

Sjablonen

Documenten

Integraties

Ontwikkelaars

Account

API-SDK's